home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / faxdor20.zip / FAXDOR20.DOC < prev    next >
Text File  |  1993-03-07  |  22KB  |  474 lines

  1.  
  2. ═════════════════════════════════════════════════════════════════════════════=
  3.  
  4.                           Fax-Door Release 2.00
  5.  
  6.                    Door Registration is only $20.00!
  7.  
  8.               Written by: Gerry Freymann
  9.                           P.O. Box 1226
  10.                           Cobourg, Ontario
  11.                           K9A 5A4
  12.  
  13.           The Phantom BBS (416) 342-3734 USR HST Dual Standard V.32
  14.                           (416) 342-3766 Hayes Ultra V.32
  15.  
  16.     The latest versions/updates are available on The Phantom BBS and
  17.  
  18.                               TDS Network
  19.                    The PC ToyShop Information System
  20.                          24 Hours, 300 -> 38.4K
  21.                              (503) 342-4447
  22.                              Eugene, Oregon
  23.  
  24. ═════════════════════════════════════════════════════════════════════════════=
  25.  
  26. Brief Update History
  27. ─────────────────────────────────────────────────────────────────────────
  28. Please view the file CHANGES.DOC for a complete history.
  29.  
  30.  
  31. Overview of Fax-Door
  32. ──────────────────────────────────────────────────────────────────────────
  33. Fax-Door was written to provide users of my BBS the chance to Fax
  34. ASCII Text files to other fax machines in the area.  I originally bought
  35. the Fax Card for my personal benefit, and once I saw how simple it was to
  36. use the BitFax software, I figured it would be a fairly simple job to
  37. create a door to take advantage of the Fax card and BitFax software.
  38.  
  39. A simple door?  Well, that's a matter of opinion I'm sure, but this is
  40. far from being "just a simple door" as you will soon see.
  41.  
  42. My Fax-Door will display information to NewUsers, create a personal ten
  43. number dialing directory, offer a variety of transfer protocols, place
  44. comments in your caller log, as well as a separate door log file, allow
  45. long distance faxing for pre-approved users (you define the number
  46. of credits or available pages), fax on-the-spot, report the fax status,
  47. update user accounts, delete all temporary files, and offers both
  48. immediate and delayed faxing!
  49.  
  50. I have the door set up to allow FREE local faxing.  What the hay?  It's
  51. a great service that is fairly cheap to add to your system so why bother
  52. the users and have them pay per fax?
  53.  
  54. All in all, I think you'll be quite pleased.
  55.  
  56.                   ***** ***** ***** ***** ***** *****
  57.  
  58.                               Version 2.0
  59.  
  60. Sysop CHUCK CORVEC contacted with a request that developed into release
  61. 2.0 - read on! (Thanks for the idea Chuck!)
  62.  
  63.                   ***** ***** ***** ***** ***** *****
  64.  
  65. New this time around is the dual operation mode of FaxDoor.  Previous
  66. versions were quite nice, but only worked on one node.  I had a request
  67. to allow delayed faxing, and after talking it over and thinking about
  68. how to institute the plan, this is what we have now:
  69.  
  70. ────────IMMEDIATE MODE───────────────────────────────────────────────
  71.  
  72. Just what it says.  When the door is configured for IMMEDIATE mode, the
  73. file the user uploads to the door is faxed while they wait.  This makes
  74. the door available on one node only, which is normally the node with
  75. both the modem and the faxmodem in it.  It's nice but limited.
  76.  
  77. ────────DELAYED MODE─────────────────────────────────────────────────
  78.  
  79. Just what it says.  When the door is configured for DELAYED mode, the
  80. user uploads his file, enters the data as to who the fax should be
  81. sent to, but instead of faxing right away, the info is held aside, and
  82. the actual faxing will take place LATER.  The user can select the (S)tatus
  83. command in the door and get a list of pending/completed faxes.  You as
  84. the Sysop decide when to actually send the fax.  I find running the
  85. fax software in an EVENT is the best, but if you have lots of RAM and
  86. want to attempt a LOGOFF session be my guest.  Edit the TODO(G).TXT
  87. files to inform your users when you send DELAYED faxes.
  88.  
  89. How do you configure the door for the above two modes?  Easy!  Edit
  90. your FAXDOOR.CFG file.  The last line should read DELAYED or IMMEDIATE.
  91. There should be 6 lines in that CFG file!
  92.  
  93.                   ***** ***** ***** ***** ***** *****
  94.  
  95.  
  96. Fax-Door Requirements
  97. ──────────────────────────────────────────────────────────────────────────
  98. First of all, Fax-Door may not be for everybody.  There are a few
  99. requirements you should be aware of, that may make this door unsuitable for
  100. some Bulletin Board Systems:
  101.  
  102. - If you are going to use the door in IMMEDIATE mode, you must have a
  103.   modem *and* a faxmodem installed in one computer.  Otherwise you just
  104.   need a fax/modem online.
  105.  
  106. - If you are going to use the door in IMMEDIATE mode you need an extra phone
  107.   line, in ADDITION to the BBS Line, as the door can fax with the caller
  108.   online.
  109.  
  110. - You need a Fax board that uses the BitFax software (C) 1989 BIT Software,
  111.   Inc.  All Rights Reserved.  I have used BitFax v.2.061 and 2.062 and 3.???
  112.   successfully.
  113.  
  114. - This only works on the node where the Fax card is inserted.  On a multi
  115.   node system, this means the fax service will only be available on one of
  116.   your nodes if you use IMMEDIATE mode.  With DELAYED mode the door works
  117.   great on any node!
  118.  
  119. - You must have a copy of DSZ in your Path
  120.  
  121. - You'll need lots of free RAM!  The door exits to DOS and runs a BATCH
  122.   file to run BitFax but shells out to DSZ to accept the uploaded file to fax.  Bulletin
  123.   Boards operating under DoubleDos or Desqview must be sure they have
  124.   enough RAM leftover for proper door operation.
  125.  
  126. - The door assumes a local call is 7 or 5 digits in length (minus brackets &
  127.   dashes).  If you are in a location where a local call is more, than you'll
  128.   need a customized version.  Please contact me and provide details and we
  129.   can get you set up.  Example local call:  3724915 or 24915
  130.  
  131. - The door also assumes that a long distance call is 8 or 11 digits in length
  132.   (minus brackets and dashes).  Again, if this a problem in your location
  133.   please contact me and we can get you set up with a customized version.
  134.   Example long distance call:  14163724915 or 13724915
  135.  
  136. - The door will ignore any phone number 4 digits or less, 6, 9 or 10 digits
  137.   or 12 and great and report these as invalid numbers.  If this is a problem
  138.   for you please contact me.
  139.  
  140. - Only 999 users may use the door with all of its bells and whistles.  The
  141.   1000th user and above will have access, but will not have a personal
  142.   dialing directory and therefore have no access to the Long Distance
  143.   option.
  144.  
  145. With all that said, if you still feel this door is for you, then by all
  146. means read on!
  147.  
  148.  
  149. Command-line parameters
  150. ──────────────────────────────────────────────────────────────────────────
  151. Once you've configured DoorPatch 3.8 you run Faxdoor in local mode by
  152. using the /LOCAL command-line switch as follows:
  153.  
  154.         FAXDOOR FAXDOOR.CFG /LOCAL   <== Allows local usage of the DOOR as
  155.                                          the SysOp.
  156.  
  157.  
  158. Files needed for Fax-Door Operation
  159. ──────────────────────────────────────────────────────────────────────────
  160. If you have any doubt about the integrity of the files contained in this
  161. ARCHive, feel free to call my BBS in Baltimore, Ontario Canada and download
  162. the latest version.
  163.  
  164.  
  165. DOOR     BAT * | Used when returning from Delayfax, explained later
  166. DELAY    BAT * | Used when returning from a Fax, explained later
  167. DELAYFAX EXE   | The Delayed fax engine
  168. FAXDOOR  CFG * | Your Configuration file, explained later
  169. FAXDOOR  EXE   | The main Fax-Door executible
  170. FAXEDIT  EXE   | User File Editor, explained later
  171. FAXDOOR  PGE * | OPTIONAL, explained later.
  172. FAXDOOR  REG   | Provided when you Register your copy, explained later
  173. FAXDOOR  PRE * | OPTIONAL list of local prefixes, explained later
  174. FAXHELP  TXT   | Help file for user while in door
  175. FAXING   TXT * | Displayed just as the door exits and goes to send the fax
  176. FAXME    BLT   | Your menu of files that the user can have faxed to them
  177. FAXME    ###   | ### = 1 to 999 - Your actual FaxBack files
  178. HELLO2   TXT * | Displayed when a user returns from sending a fax
  179. MENU     TXT * | The Main Menu
  180. MINUS    TXT * | Displayed when attempting to fax LD with a deficit balance
  181. NEWUSER  TXT * | Displayed once, to every new user of the Door
  182. PLUS     TXT * | Displayed before a Long Distance fax if credits remain
  183. TODO     TXT * | Displayed to user after accepting a Delayed Fax order
  184. XM1KG    BAT * | Xmodem-G transfer batch file (set to use Com1)
  185. XMD1K    BAT * | Xmodem-1K transfer batch file (set to use Com1)
  186. XMDCRC   BAT * | Xmodem-CRC transfer batch file (set to use Com1)
  187. YMD      BAT * | Ymodem transfer batch file (set to use Com1)
  188. YMD1KG   BAT * | Ymodem-1KG transfer batch file (set to use Com1)
  189. ZERO     TXT * | Displayed when attempting to fax LD with no credits left
  190. ZMD      BAT * | Zmodem transfer batch file (set to use Com1)
  191. FAX          * | Sample Batch file to activate the Door, explained later
  192. FAXDOR20 DOC   | This documentation
  193. CHANGES  DOC   | History file listing changes in each version
  194. FAXDV    DOC * | Jon's brain storm on a DV Receive Fax window!
  195. FLYER    DOC   | List of other programs available from me
  196. LICENSE  DOC   | Please read, understand and agree with
  197. SYSOP    DOC   | DoorPatch 3.8 setup instructions
  198. ORDER    FRM   | Print out, complete and mail with register fee
  199. QUICKGO  DOC   | Quick, no muss, no fuss installation & set up
  200. ECHOFAX  DOC   | Information on a message base fax utility now available!
  201.  
  202. Files created by the door
  203.  
  204. FAX      BAT   | Temporary batch file, explained later
  205. DOFAX    YES   | Temporary batch file, explained later
  206. FAXDOR## LOG   | Log file in the door subdirectory of user actions
  207. FAXDOOR  ###   | User Data files, 001-999, explained later
  208. FAXDOOR  DTA   | Master list of User names and their Data File Name
  209. TODO     FAX   | Random access file listing pending fax status
  210.  
  211. Files marked with an asterisk (*) mean you should go over and edit these
  212. files as you see fit.  Be sure to check the transfer batch files so they
  213. are set for the correct com port that the door will be using.
  214.  
  215. All of the above files should be in the same subdirectory as your BitFax
  216. program.  Explainations of their purposes follow.
  217.  
  218.  
  219. DOOR.BAT --> Keep in your Door/BitFax Subdirectory
  220. ──────────────────────────────────────────────────────────────────────────
  221. ECHO OFF
  222. FAXDOOR FAXDOOR.CFG
  223. IF EXIST DOFAX.YES FAX
  224. C:
  225. CD\PCB
  226. BOARD
  227.  
  228. You will need to edit this file, if your PCB subdirectory is not located
  229. on Drive C: subdirectory \PCB.  This file is called by the door after
  230. sending a fax and is used to allow the Fax-Door to recycle.
  231. YOU MUST HAVE THIS FILE IN THE DOOR/BITFAX SUBDIRECTORY AND IT MUST HAVE
  232. CORRECT DRIVE LETTERS AND PATHS.
  233.  
  234. DELAY.BAT --> Keep in your Door/BitFax Subdirectory
  235. ─────────────────────────────────────────────────────────────────────────
  236. ECHO OFF
  237. DELAYFAX %1
  238. IF EXIST DOFAX.YES FAX
  239.  
  240. This batch file should be CALLED in your Event (or Logoff I suppose) and
  241. will execute the delayed fax feature of Faxdoor, maintaining the door's
  242. file integrity.  It handles the sending of the pending faxes, updates
  243. user files as required, deletes successfully faxed uploads, and updates
  244. the TODO.FAX file status.
  245.  
  246.  
  247. FAXDOOR.CFG --> Keep in your Door/BitFax Subdirectory
  248. ──────────────────────────────────────────────────────────────────────────
  249. C:\PCB\PCBOARD.SYS   | Location of your PCBoard.Sys file
  250. The Phantom BBS      | Your BBS Name
  251. Gerry                | Sysop First Name
  252. Freymann             | Sysop Last Name
  253. Donor Name           | The donor of the DOOR
  254. DELAYED or IMMEDIATE | DELAYED will enable that feature
  255.  or DEBUG            | DEBUG will activate the faxdebug.out log to help
  256.                      | in debuggin!
  257.                      | IMMEDIATE will provide online faxing
  258.  
  259.  
  260. FAXDOOR.PGE --> Place in your Door/BitFax Subdirectory
  261. ──────────────────────────────────────────────────────────────────────────
  262. This OPTIONAL file allows you to customize the appearance of your Fax
  263. service.  This file can be up to 51 lines long and will be combined with
  264. the existing covering letter.
  265.  
  266.  
  267. FAXDOOR.REG --> Place in your Door/BitFax Subdirectory
  268. ──────────────────────────────────────────────────────────────────────────
  269. Our new registration process will create this file for you.  When you
  270. register, you are given a small utility program that you run from within
  271. the door subdirectory.  Once you have a valid REG file, the door which
  272. you are already running will magically say Registered to you.
  273.  
  274.  
  275. FAXEDIT.EXE --> Place in your Door/BitFax Subdirectory
  276. ──────────────────────────────────────────────────────────────────────────
  277. This is a very nice user file editor for use with the door.  An easy way
  278. to add credits to a user account, or edit somebody's dialing directory,
  279. or just plain be nosy!  One catch.... this only works when you Register
  280. your copy of the Door.  To load the door, pass on the name of one of your
  281. Faxdoor configuration files.  For example:  FAXEDIT FAXDOOR.CFG
  282.  
  283.  
  284. FAXDOOR.PRE --> Place in your Door/BitFax Subdirectory
  285. ──────────────────────────────────────────────────────────────────────────
  286. 342
  287. 349
  288. 352
  289. 372
  290. 373
  291. 797
  292. 885
  293.  
  294. This file gives you the chance to ensure that when a user enters a "local"
  295. number, it is indeed a valid local number.  Simply place all valid local
  296. dialing prefixes, one per line in this file.  THIS FILE IS OPTIONAL!  If
  297. you do not create a FaxDoor.Pre file, no validity checks will take place.
  298. As you can see, I don't have a whole heck of a lot of local exchanges, so
  299. it was a piece of cake for me, but in Metropolitan areas, you might spend
  300. a day typing in all the exchanges and might be better off to leave it out!
  301.  
  302.  
  303. *.TXT --> Place in your Door/BitFax Subdirectory
  304. ──────────────────────────────────────────────────────────────────────────
  305. These text files are displayed to the user at various points throughout
  306. the door.  You will need to edit some of them, depending on how you wish
  307. to run the door.  I grant free local faxing and the text files provided
  308. display that to the users.  I charge for Long Distance faxing, on a prepaid,
  309. preapproved basis and the text files display that.  You may change and/or
  310. edit any or all of these files as you see fit.
  311.  
  312.  
  313. *.BAT --> Place in your Door/BitFax Subdirectory
  314. ──────────────────────────────────────────────────────────────────────────
  315. These are all of your Upload Protocol transfer batch files.  You should
  316. edit these if you aren't using Com1 to run the Fax-Door.
  317.  
  318.  
  319. FAX  --> Place in your \PCB Subdirectory
  320. FAX.BAT --> Created and maintained by the Door
  321. DOFAX.YES --> Created and maintained by the Door
  322. ──────────────────────────────────────────────────────────────────────────
  323. ECHO OFF                       | Turn Echo OFF
  324. CD\BITFAX                      | Change Directory to the BitFax/Door area
  325. FAXDOOR FAXDOOR.CFG            | Load the door and using the .cfg file
  326. IF EXIST DOFAX.YES FAX         | Key file maintained by the door
  327. CD\PCB                         | Change back to main \PCB area
  328. BOARD                          | Reload the BBS
  329.  
  330. This is my door batch file that calls up the FaxDoor.  Using the name "FAX"
  331. a user can simply type FAX at the PCBoard 14.5 prompt and be taken into
  332. the Fax door.  The If Exist line is the key to calling up the BitFax
  333. software.  The door will automatically create a FAX.BAT file which will
  334. instruct BitFax on what file to send and what number to dial.  The end of
  335. FAX.BAT calls DOOR.BAT (Door.Bat is provided and was discussed earlier)
  336. and allows the Fax-Door to reload and gather stats etc.  The file DOFAX.YES
  337. is also created by the door and holds some data which the door reads after
  338. sending the fax to complete the statistic gathering.  Both of these files
  339. are deleted automatically by the door.
  340.  
  341.  
  342. FAXDOOR.###  --> Created and maintained by the Door
  343. ──────────────────────────────────────────────────────────────────────────
  344. "PHANTOM BBS","342-3766"
  345. "**","**"
  346. "**","**"
  347. "**","**"
  348. "**","**"
  349. "**","**"
  350. "**","**"
  351. "**","**"
  352. "**","**"
  353. "**","**"
  354. " 0","N"
  355.  
  356. These files are the User Files created by the door.  They are numbered
  357. 001 to 999.  The format is very simple.  It's an ASCII file with two
  358. fields per line, separated by a comma with each field surrounded by
  359. quotation marks.  The first field is a description of the number and
  360. the second field is the actual fax number.  There are ten lines providing
  361. each user with their very own personal ten number dialing directory.  A
  362. user may enter a number manually or dial a number contained in their
  363. directory.
  364.  
  365. The last line is rather unique.  The first field of the eleventh line
  366. will start at zero.  If you wish to grant Long Distance faxing to a user
  367. you need to read FAXDOOR.DTA to get their filename, then edit this line
  368. in their file and insert the number of "credits" or pages you wish them
  369. to have.  Try to remember to leave a leading space before the number?
  370. The door will only allow a person to fax to a long distance number if they
  371. have a postive value.  If they have 0 or a negative number, no long distance
  372. faxing will be allowed (local faxes remain available).  The door will
  373. maintain the number of credits for you and displays certain TXT files
  374. after a successful fax based on the value in this field.
  375.  
  376. The second field is not in use at this time and has been left in for
  377. future uses.  Both fields, as with the rest of the datafile, should be
  378. surrounded by quotes and separated by a comma.
  379.  
  380. If you register your copy of Fax-Door the FAXEDIT program will magically
  381. start to work and you won't really have to bother with all this stuff.
  382.  
  383. Only 999 users may use the door with all of its bells and whistles.  The
  384. 1000th user and above will have access, but will not have a personal
  385. dialing directory and therefore have no access to the Long Distance
  386. option.
  387.  
  388.  
  389. FAXDOOR.DTA  --> Created and maintained by the Door
  390. ──────────────────────────────────────────────────────────────────────────
  391. "USER ONE","FAXDOOR.001"
  392. "USER TWO","FAXDOOR.002"
  393. "USER THREE","FAXDOOR.003"
  394. "USER FOUR","FAXDOOR.004"
  395.  
  396. This is only a sample of the Data file created by the door.  It is a simple
  397. ASCII file with two fields per line, surrounded by quotation marks and
  398. separated by a comma.  The first field is the User Name and the second
  399. field is the name of their personal data file (explained above).  You are
  400. limited to 1000 users!
  401.  
  402.  
  403. FAXDOR## LOG  --> Created and maintained by the Door
  404. ──────────────────────────────────────────────────────────────────────────
  405. **************************************************************
  406. GERRY FREYMANN entered FAX-DOOR 02-13-1991 22:58:28
  407. Uploaded TEST.FAX using Zmodem
  408. Dial (A)borted!
  409. **************************************************************
  410. GERRY FREYMANN entered FAX-DOOR 02-13-1991 23:50:38
  411. Uploaded TEST.FAX using Zmodem
  412. Faxing TEST.FAX to 3425544
  413. CFMX.FAX      1     00:25    OK
  414. Uploaded TEST.DOC using Zmodem
  415. File transfer was UNSUCCESSFUL.
  416.  
  417. This is a log file that the door appends to, giving you a history of
  418. activity in the door.  If you are running on a multinode system you will
  419. see the node number appended to the end of the prefix.  Since this file
  420. appends, you may wish to delete or archive it periodically.
  421.  
  422.  
  423. FAXDV.DOC --> Created by Jon Anderson, used by permission
  424. ──────────────────────────────────────────────────────────────────────────
  425. Information and complete batch file to open a window in Desqview for a
  426. receive fax option using BitFax 3.0 - take a peek!
  427.  
  428.  
  429. Setting up BitFax
  430. ──────────────────────────────────────────────────────────────────────────
  431. I followed the instructions for BitFax when installing the software and
  432. suggest you do the same.  Make a subdirectory called BITFAX on your drive,
  433. change to the subdirectory, and copy the contents of the BitFax/SR Program
  434. disk into the subdirectory.  You should place the Fax-Door files in this
  435. same directory, as the Fax-Door will read the Log file created by BitFax.
  436. You should set the BITFAX=\BITFAX environment variable in your autoexec.bat
  437. file, and include the BITFAX subdirectory in your PATH= statement.
  438.  
  439. Be sure to set your com port correctly on the fax card.  I run a Hayes
  440. Ultra on Com1 and have the fax card set to use Com3/IRQ 4.  I elected
  441. to have the Modem Speaker OFF at all times... it is rather loud!
  442.  
  443. Once your card is installed and your software is loaded onto the hard
  444. drive you should type BITFAX and set up the BitFax parameters.  Please
  445. follow the BitFax manual.  Their manual contains step by step instructions.
  446.  
  447.  
  448. Registration Cost
  449. ──────────────────────────────────────────────────────────────────────────
  450. The DOOR only costs $20.00!!  It is a full working version and is not
  451. crippled in anyway.
  452.  
  453.  
  454. Support the Shareware concept...
  455. ──────────────────────────────────────────────────────────────────────────
  456. To Register, please print out and return the ORDER.FRM in the Zip file.
  457. Now, when you register, you will be given a small program which you run in
  458. your door subdirectory.  This program will create a *.REG which will
  459. instantly register your existing copy of the door program, and any and all
  460. future versions as well.  This means that any future releases you find will
  461. automatically continue to say registered to you, without the need to come
  462. back to me.  I hope you'll appreciate this new system.  You should be able
  463. to call The Phantom BBS and make your initial call, wait until I receive
  464. your payment, and download this small utility without spending alot of time
  465. on the phone.  Or, for an additional $5.00 per order, I can send you the
  466. whole package on disk using the postal service.  The choice is yours.
  467. There is an Update Door which grants access to all Registered Users, and
  468. allows you to download your register utilities for the programs you have
  469. registered.
  470.  
  471.  
  472. Thanks for your support!
  473.  
  474.